Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(robot): add block disk back to previously deleted node for v2 test cases #2190

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

yangchiu
Copy link
Member

@yangchiu yangchiu commented Dec 13, 2024

Which issue(s) this PR fixes:

Issue longhorn/longhorn#10001

What this PR does / why we need it:

add block disk back to previously deleted node for v2 test cases

Special notes for your reviewer:

Additional documentation or context

Summary by CodeRabbit

  • New Features
    • Introduced a new keyword for adding deleted nodes back in Kubernetes.
  • Improvements
    • Enhanced existing keywords for draining volumes to capture the last volume node before operations.
    • Updated the drain completion keyword to ensure all pods are evicted before confirming the process.
    • Added retry logic to the disk addition process for improved reliability and error handling.

@yangchiu yangchiu self-assigned this Dec 13, 2024
@yangchiu yangchiu requested a review from a team as a code owner December 13, 2024 07:19
Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request introduces enhancements to Kubernetes-related keywords in the e2e/keywords/k8s.resource file and modifies the add_disk method in the Node class within e2e/libs/node/node.py. A new keyword for adding deleted nodes is added, along with updates to existing keywords to improve state management during volume drain operations. The add_disk method now includes a retry mechanism for adding disks, enhancing error handling and logging.

Changes

File Path Change Summary
e2e/keywords/k8s.resource - New keyword: Add deleted node back added.
- Updated: Force drain volume of ${workload_kind} ${workload_id} volume node (added ${last_volume_node}).
- Updated: Force drain volume of ${workload_kind} ${workload_id} replica node (added ${last_volume_node}).
- Updated: The drain process completed (added wait for all pods evicted).
e2e/libs/node/node.py - Updated method: add_disk(self, node_name, disk) (added retry mechanism and enhanced error logging).

Possibly related PRs

Suggested reviewers

  • chriscchien

Poem

🐇 In the land of nodes where volumes play,
A new keyword hops in to save the day!
With retries in place, disks find their way,
Kubernetes dances, come join the fray!
So let us rejoice, with a leap and a bound,
For the magic of code is where joy is found! ✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
e2e/keywords/k8s.resource (1)

34-36: Consider enhancing the keyword implementation

  1. Add documentation to describe the keyword's purpose and parameters
  2. Consider moving the disk paths to constants
  3. Use more descriptive variable names (e.g., block_disk_path instead of disk_path)
+ [Documentation]    Adds a block disk back to a previously deleted node
+
+ *** Variables ***
+ ${HARVESTER_BLOCK_DISK_PATH}    /dev/vdc
+ ${DEFAULT_BLOCK_DISK_PATH}      /dev/xvdh
+
 Add deleted node back
     reboot_node_by_name    ${deleted_node}
     ${host_provider}=    Get Environment Variable    HOST_PROVIDER
-    ${disk_path}=    Set Variable If    "${host_provider}" == "harvester"    /dev/vdc    /dev/xvdh
+    ${block_disk_path}=    Set Variable If    "${host_provider}" == "harvester"    ${HARVESTER_BLOCK_DISK_PATH}    ${DEFAULT_BLOCK_DISK_PATH}
-    add_disk    block-disk    ${deleted_node}    block    ${disk_path}
+    add_disk    block-disk    ${deleted_node}    block    ${block_disk_path}
e2e/libs/node/node.py (1)

65-77: Enhance method implementation and fix static analysis warning

The retry mechanism is well implemented, but consider these improvements:

  1. Fix the unused loop variable warning
  2. Add method documentation
  3. Add type hints for better code maintainability
-    def add_disk(self, node_name, disk):
+    def add_disk(self, node_name: str, disk: dict) -> None:
+        """Add a disk to a node with retry mechanism.
+        
+        Args:
+            node_name: Name of the node to add the disk to
+            disk: Dictionary containing disk configuration
+            
+        Raises:
+            AssertionError: If adding the disk fails after all retries
+        """
         added = False
-        for i in range(self.retry_count):
+        for _ in range(self.retry_count):
             try:
                 node = get_longhorn_client().by_id_node(node_name)
                 disks = node.disks
🧰 Tools
🪛 Ruff (0.8.2)

66-66: Loop control variable i not used within loop body

Rename unused i to _i

(B007)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f360ab1 and 4707978.

📒 Files selected for processing (2)
  • e2e/keywords/k8s.resource (1 hunks)
  • e2e/libs/node/node.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
e2e/libs/node/node.py

66-66: Loop control variable i not used within loop body

Rename unused i to _i

(B007)

🔇 Additional comments (1)
e2e/libs/node/node.py (1)

65-77: Implementation aligns well with class design

The retry mechanism implementation is consistent with the class's error handling patterns and properly utilizes the existing retry infrastructure.

🧰 Tools
🪛 Ruff (0.8.2)

66-66: Loop control variable i not used within loop body

Rename unused i to _i

(B007)

Copy link
Contributor

@chriscchien chriscchien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants